home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dbase / lib19.zip / LIB19TOC.ZIP / LIB19TOC.TXT
Text File  |  1992-10-14  |  59KB  |  1,071 lines
  1. ===============================================================================
  2.                                 LIB19TOC.TXT
  3.                               Table of Contents
  4.                     For the dUFLP LIBRARY Files (attached)
  5.                (dUFLP = dBASE User's Function Library Project)
  6.                                Version 1.9
  7.                                  10/14/92
  8. ===============================================================================
  9. Some of the places routines are placed may seem a bit arbitrary -- they are. 
  10. These decisions were made based on the functions/procedures I use the most in 
  11. my own routines. Since the original purpose of this library was my own use, 
  12. I felt it my prerogative to be the one to make the final decision as to what 
  13. routines were left in PROC.PRG, and which got moved to the LIBRARY files. 
  14.  
  15. Included in this LIBRARY System are the following files:
  16.  
  17. Text Files
  18. README.TXT   -- You're looking at it.
  19. WHATS.NEW    -- This is a description of the new features for this system.
  20. CONTRIB.TXT  -- How to contribute to the Library Project.
  21. JPMOUSE.TXT  -- An explanation from Jay on the JPMOUSE.BIN file, attached
  22.                 (with his permission). See also the function ISMOUSE() and
  23.                 procedure file SETMOUSE in PROC.PRG.
  24. DISK.TXT     -- A very brief discussion on the use of DISK.BIN.
  25. SEARCH.TXT   -- A very brief discussion on the use of SEARCH.BIN.
  26.  
  27. Procedure and Library Files -- Described Below
  28. ARRAY.PRG
  29. COLOR.PRG
  30. CONVERT.PRG
  31. DATES.PRG
  32. FIELDS.PRG
  33. FILES.PRG
  34. FINANCE.PRG
  35. FRPG.PRG
  36. MEASURE.PRG
  37. MISC.PRG
  38. NAVIGATE.PRG
  39. OBSOLETE.PRG
  40. PROC.PRG
  41. SCA.PRG
  42. SCREEN.PRG
  43. STATS.PRG
  44. STRINGS.PRG
  45. TIME.PRG
  46. TRIG.PRG
  47. WINDOWS.PRG
  48.  
  49. BIN Files -- used in routines attached.
  50. JPMOUSE.BIN
  51. DISK.BIN
  52. SEARCH.BIN
  53.  
  54. Below is a quick list of all the procedures and functions included in the 
  55. library files in the sequence they are presented in the programs themselves:
  56.  
  57. ===================================
  58. PROC.PRG -- The MAIN PROCEDURE File
  59. ===================================
  60.  
  61. ----------------------------------
  62. MESSAGE/SCREEN PROCESSING ROUTINES
  63. ----------------------------------
  64. PrintErr    -- used to display a "standard" error message for printer 
  65.                errors (is it on, online, out of paper?).
  66.                Usage: do PrintErr
  67. Open_Screen -- Used to add texture to the background for an opening screen or
  68.                menu.
  69.                Usage: do Open_Screen
  70. JazClear    -- performs a nice center to edge of screen clear (using a box) ...
  71.                Usage: do JazClear
  72. Wipe        -- performs a left-to-right wipe of a window. Nice effect.
  73.                Usage: do Wipe with <nULRow>,<nULCol>,<nBRRow>,<nBRCol>
  74. Center      -- used to center text anywhere on the screen (optional colors).
  75.                Usage: do Center with <nRow>,<nWidth>,"<cColors>","<cText>"
  76. Surround()  -- Used to display text at X,Y position, surrounded with a double-
  77.                line box.
  78.                Usage: Surround(<nRow>,<nCol>,"<cColor>","<cText>")
  79. Message1()  -- Displays a single-line message, waits for user to press a key
  80.                before program moves on.
  81.                Usage: Message1(<nRow>,<nWidth>,"<cColor>","<cText>")
  82. Message2()  -- Same as above, but displays message in a window (with shadow).
  83.                Usage: Message2("<cText>","<cColor>")
  84. Message3()  -- Same as above, but will handle LONG messages, wrapping inside
  85.                window.
  86.                Usage: Message3("<cText>","<cColor>")
  87. Message4()  -- 2-Line message in a window, pauses for user.
  88.                Usage: Message4("<cText1>","<cText2>","<cColor>")
  89. Monitor     -- Displays a box, showing total records in database -- is designed
  90.                to be used in a system that does a record-by-record update, 
  91.                so the user knows something is happening. You need to add code
  92.                to display actual record numbers as the task is happening.
  93.                Usage: do Monitor with "<cText>","<cColors>"
  94. Monitoroff  -- Cleanup for Monitor procedure above.
  95.                Usage: do MonitorOff
  96. ScrnHead()  -- Used to display a screen header inside a box (with a shadow).
  97.                Usage: ScrnHead("<cColor>","<cText>")
  98. YesNo()     -- Used to ask a "yes/no" type question, allows three lines of 
  99.                message, and uses menu pads to choose (move cursor, press 
  100.                <enter>).
  101.                Usage: YesNo(<lAnswer>,"<cMess1>","<cMess2>","<cMess3>",;
  102.                              "<cColors>")
  103. YesNo2()    -- As above, but allows programmer to choose position on screen.
  104.                Usage: YesNo2(<lAnswer>,"<cWhere>","<cMess1>","<cMess2>",;
  105.                            "<cMess3>","<cColors>")
  106.                    where cWhere may be one of the following:
  107.                          UL = Upper Left
  108.                          UC = Upper Center
  109.                          UR = Upper Right
  110.                          CL = Center Left
  111.                          CC = Center Center
  112.                          CR = Center Right
  113.                          BL = Bottom Left
  114.                          BC = Bottom Center
  115.                          BR = Bottom Right
  116.                    Anything else will default to CC.
  117. ErrorMsg()  -- Allows 2 lines of message, first is ** ERROR **, or optionally,
  118.                ** ERROR # **  where '#' is a number (if "<cErr>" is empty,
  119.                (""), system uses first option, but there must be SOMETHING
  120.                there). 
  121.                Usage: ErrorMsg("<cErr>","<cMess1>","<cMess2>","<cColors>")
  122. Shadow      -- Used for windows/boxes to display a shadow, giving 3-D effect.
  123.                Usage: do Shadow with <nULRow>,<nULCol>,<nBRRow>,<nBRCol>
  124. VPick()     -- Multiple-item Picklist -- this routine will allow you to create
  125.                a simple vertical picklist of items, returning the first letter 
  126.                of the option selected, or a null string if the user pressed 
  127.                <Esc>.
  128.                Usage: VPick(<nRow>,<nCol>,"<~Option1~Option2~Option3>",;
  129.                              "<cTitle>","<cMessage>",<lShadow>,<cColor>)
  130. HPick()     -- Very much like VPICK() above, but does a Horizontal Picklist.
  131.                Usage: HPick(<nRow>,<nCol>,"<~Option1~Option2~Option3>",;
  132.                              "<cTitle>","<cMessage>",<lShadow>,<cColor>)
  133.  
  134. -------------------------
  135. COLOR PROCESSING ROUTINES
  136. -------------------------
  137. SetColor    -- Sets colors to contents of a memvar to handle various parts of
  138.                the screen. THIS IS A NEW ROUTINE -- USERS OF THE OLD 
  139.                SETCOLOR and SETCOLOR2 ROUTINES SHOULD CHECK "OBSOLETE.PRG".
  140.                Usage: do SetColor with <cColorVar>
  141. ReColor     -- Restores colors to those held in a string of the form returned
  142.                by SET("ATTRIBUTE").
  143.                Usage: Do ReColor with <cColors>
  144. ColorBrk()  -- Returns one of three portions of a color variable as used in
  145.                many of my own routines (YESNO, etc.). Used for explicitly
  146.                setting colors.
  147.                Usage: ColorBrk(<cColorVar>,<nField>)
  148.  
  149. ----------------------------
  150. STRING MANIPULATION ROUTINES
  151. ----------------------------
  152. AllTrim()   -- Trims both sides of a character field/memvar.
  153.                Usage: AllTrim(<cString>)
  154. State()     -- This is used for validation of a STATE (two letter) code ... 
  155.                (returns .t. or .f.) -- useful for data entry.
  156.                Usage: State(<cState>)
  157.  
  158. ----------------------
  159. DATE HANDLING ROUTINES
  160. ----------------------
  161. DateText()  -- Convert date to Month Day, Year format.
  162.                Usage: DateText(<dDate>)
  163. DateText2() -- As above, adds day of week (DoW, Month Day, Year).
  164.                Usage: DateText2(<dDate>)
  165. Age()       -- Returns the age of someone as of DATE(), given their birthdate.
  166.                Usage: Age(<dDate>)
  167.  
  168. -----------------------
  169. FIELD HANDLING ROUTINES
  170. -----------------------
  171. IsUnique()  -- Used to check a keyfield in a database to see if it's unique.
  172.                Usage: IsUnique(<xValue>,<cOrder>)
  173.  
  174. --------------
  175. MISC. ROUTINES
  176. ---------